/*
 *  linux/kernel/vsprintf.c
 *
 *  (C) 1991  Linus Torvalds
 */

/* vsprintf.c -- Lars Wirzenius & Linus Torvalds. */
/*
 * Wirzenius wrote this portably, Torvalds fucked it up :-)
 */

#include <stdarg.h>
#include <string.h> 

/* we use this so that we can do without the ctype library */
// 判断字符是不是数字字符。取ascii 0-9，不包含十六进制
#define is_digit(c)	((c) >= '0' && (c) <= '9')

// 字符串转整数，同时原s的指针前移
// 调用时使用的是atoi(&fmt)，即从fmt指向的中口取出数字，最后将结束位置更新到fmt中
static int skip_atoi(const char **s)
{
	int i=0;

	while (is_digit(**s))
		// 下面用了++，所以会将指针前移
		i = i*10 + *((*s)++) - '0';
	return i;
}

// 读写标志位
#define ZEROPAD	1		/* pad with zero */
#define SIGN	2		/* unsigned/signed long */
#define PLUS	4		/* show plus */
#define SPACE	8		/* space if plus */
#define LEFT	16		/* left justified */
#define SPECIAL	32		/* 0x */
#define SMALL	64		/* use 'abcdef' instead of 'ABCDEF' */

#define do_div(n,base) ({ \
int __res; \
__asm__ __volatile__("divl %4":"=a" (n),"=d" (__res):"0" (n),"1" (0),"r" (base)); \
__res; })

// 字符串转数字
static char * number(char * str, int num, int base, int size, int precision ,int type)
{
	char c,sign,tmp[36];
	const char *digits="0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
	int i;

	// 查找表
	if (type&SMALL) digits="0123456789abcdefghijklmnopqrstuvwxyz";

	// 边界对齐检查，取沙0填充
	if (type&LEFT) type &= ~ZEROPAD;

	// 进制检查，不合法的跳过
	if (base<2 || base>36)
		return 0;
	c = (type & ZEROPAD) ? '0' : ' ' ;		// 填0或者填空格
	if (type&SIGN && num<0) {
		// 有符号且<0，加上负号
		sign='-';
		num = -num;
	} else
		// 有+号则显示+号，否则用空格
		sign=(type&PLUS) ? '+' : ((type&SPACE) ? ' ' : 0);
	
	// 有符号位，长度减1，用于放置符号位
	if (sign) size--;
	// 有特殊显示，扣掉0或者0x/0X开头的两个字符
	if (type&SPECIAL) {
		if (base==16) size -= 2;
		else if (base==8) size--;
	}

	i=0;
	if (num==0)		// num为0，则填0
		tmp[i++]='0';
	else while (num!=0)		// 不为0，则进行转换
		// 方法是不断地求余，取最低位
		tmp[i++]=digits[do_div(num,base)];

	// 如果长度超过了精度，则扩充，显示多一些
	if (i>precision) precision=i;
	size -= precision;		// 扣掉显示的部分
	if (!(type&(ZEROPAD+LEFT)))		// 如果左侧填0的需求
		while(size-->0)				// 则将其余部分填0
			*str++ = ' ';
	// 如果有符号位，则将符号位写入
	if (sign)
		*str++ = sign;

	// 如果有特殊的要求，则根据进制显示0或者0X等
	if (type&SPECIAL) {
		if (base==8)
			*str++ = '0';
		else if (base==16) {
			*str++ = '0';
			*str++ = digits[33];
		}
	}

	// 如果非左侧对齐，即右侧对齐,其余部分填0或者空格，前面有设置
	if (!(type&LEFT))
		while(size-->0)
			*str++ = c;

	// i为数字数字的个数，如果小于精度，则放入0
	while(i<precision--)
		*str++ = '0';
	
	// 将数字写入str，注意是从tmp中逆序取出
	while(i-->0)
		*str++ = tmp[i];

	// 其余部分再填0
	while(size-->0)
		*str++ = ' ';
	return str;
}

/**
 * @brief 格式化字符串
 * fmt的格式：%[flags][width][.precision][length]specifier，即：%[标志][最小宽度][.精度][类型长度]
 * %：表示格式说明的起始符号，不可缺少。
 * -：表示左对齐输出，如省略表示右对齐输出。
 * 0：有0表示指定空位填0,如省略表示指定空位不填。
 * m.n：m指 域宽，即对应的输出项在输出设备上所占的字符数。（如果数据的位数小于 m，则左端补以空格，若大于 m，则按实际位数输出）；n指 精度。用于说明输出的实型数的小数位数。未指定n时，隐含的精度为n=6位。
 * h: 用于将整型的格式字符修正为short型。
 * printf("%2d", num);
 * printf("%-2d", num); 左对齐，2个字符
 * printf("%-*d", count, num); 左对刘
 */
int vsprintf(char *buf, const char *fmt, va_list args)
{
	int len;
	int i;
	char * str;
	char *s;
	int *ip;

	int flags;		/* flags to number() */

	int field_width;	/* width of output field */
	int precision;		/* min. # of digits for integers; max
				   number of chars for from string */
	int qualifier;		/* 'h', 'l', or 'L' for integer fields */

	// vsprintf("Hello, world %d %d %d", 1, 2, 3);
	// 逐个扫描fmt中的字符，格式化写入buf
	for (str=buf ; *fmt ; ++fmt) {
		// 不是%开头，普通的字符，直接写入buf
		if (*fmt != '%') {
			*str++ = *fmt;
			continue;
		}
			
		/* process flags */
		// 遇到%开头的串
		flags = 0;

		// 1、先获取标志符
	repeat:
		++fmt;		/* 跳过%号 '%' */
		switch (*fmt) {
			// %-0 这些可以连续设置，所以这里就检查了，然后再次重复检查这些标志位
			case '-': flags |= LEFT; goto repeat;			// 显示左对齐
			case '+': flags |= PLUS; goto repeat;			// 在数值前面放一个+或-，即符号位，而不是负号有
			case ' ': flags |= SPACE; goto repeat;			// 如果是正数，前面留一个空格
			case '#': flags |= SPECIAL; goto repeat;		// 加一些特殊控制，如八进制，以0开头，十六进制，以0x或0X开头等
			case '0': flags |= ZEROPAD; goto repeat;		// 有空白时，以0填充
			}
		
		/* get field width */
		// 取宽度，转换宽度数据
		field_width = -1;
		if (is_digit(*fmt))
			field_width = skip_atoi(&fmt);
		else if (*fmt == '*') {
			// 取参数中的数字，如果<0，则左对齐
			/* it's the next argument */
			field_width = va_arg(args, int);
			if (field_width < 0) {
				field_width = -field_width;
				flags |= LEFT;
			}
		}

		/* get the precision */
		// 取精度部分，应当是在.后面的，这部分可能没有
		precision = -1;
		if (*fmt == '.') {
			++fmt;		// 跳过.
			if (is_digit(*fmt))		// 转换成精度数字
				precision = skip_atoi(&fmt);
			else if (*fmt == '*') {
				/* it's the next argument */
				// 这里没给，从参数表中获取
				precision = va_arg(args, int);
			}

			// 精度值至少为0
			if (precision < 0)
				precision = 0;
		}

		/* get the conversion qualifier */
		// 取长度域，16位，32位这种整型，比如%ld
		qualifier = -1;
		if (*fmt == 'h' || *fmt == 'l' || *fmt == 'L') {
			qualifier = *fmt;
			++fmt;
		}

		// 检查specifier，看看以什么格式显示
		switch (*fmt) {
		case 'c':	// 普通字符
			if (!(flags & LEFT))
				// 如果是右对齐，前面应当放空格填充到指定宽度，然后再放自己的这个字符
				while (--field_width > 0)
					*str++ = ' ';
			*str++ = (unsigned char) va_arg(args, int);  // 写入字符

			// 如果不是右对齐，即左对齐，则filed_width应当，写空格应当在填充字符后边
			while (--field_width > 0)
				*str++ = ' ';
			break;

		case 's':		// 字符串
			s = va_arg(args, char *);			// 取字符串的首地址参数
			len = strlen(s);					// 取长度

			// 这个精度域看起来是指字符串本身的显示长度
			if (precision < 0)		// 严谨小于0，则使用len
				precision = len;
			else if (len > precision)	// 长度 > 精度
				len = precision;		// 长度要减小

			if (!(flags & LEFT))
				// 右对齐。左边写放一些字符，直到剩余的长度和len相同，用于放剩下的字符串
				while (len < field_width--)
					*str++ = ' ';

			// 拷贝字符串
			for (i = 0; i < len; ++i)
				*str++ = *s++;

			// 右对齐时，剩余部分写空格字符
			while (len < field_width--)
				*str++ = ' ';
			break;

		case 'o':
			// 8进制，进行转换成8进制
			str = number(str, va_arg(args, unsigned long), 8,
				field_width, precision, flags);
			break;

		case 'p':		// 打印指针类型
			// 未指定宽度，则显示8，前面以0来填充
			if (field_width == -1) {
				field_width = 8;
				flags |= ZEROPAD;		// 填充0
			}
			// 转换成16进制显示
			str = number(str,
				(unsigned long) va_arg(args, void *), 16,
				field_width, precision, flags);
			break;

		// 16进制
		case 'x':		// 小写
			flags |= SMALL;
		case 'X':		// 大写
			str = number(str, va_arg(args, unsigned long), 16,
				field_width, precision, flags);
			break;

		// 19进制
		case 'd':
		case 'i':
			flags |= SIGN;		// 有符号数
		case 'u':				// 无符号数
			str = number(str, va_arg(args, unsigned long), 10,
				field_width, precision, flags);
			break;

		// 统计出现在 %n 之前的字符数，并将该值赋值给参数变量
		// printf("geeks for %ngeeks ", &c);
		// 上面的程序打印“geeks for geeks 10”
		case 'n':
			ip = va_arg(args, int *);			// 取&c的值
			*ip = (str - buf);					// 将之前的字符数给到n
			break;

		// 还遇到%，跳过
		default:
			if (*fmt != '%')
				*str++ = '%';
			
			// 遇到其它字符，写入串中，继续前移
			if (*fmt)
				*str++ = *fmt;
			else
				// 0字符，往回移一个单元。这样跳出去后，在while循环中就可以退出了
				--fmt;
			break;
		}
	}
	*str = '\0';

	// 返回总的字符数量，不包含\0
	return str-buf;
}
